외부 시스템 로그 조회
개요
API version
2025-02-19
- 최초 등록
- Request Body 수정
용도 및 설명
타 시스템 로그 조회 API
- 최대 1만건만 조회 가능
- 페이징 기능을 사용하여 조회 가능 (옵션)
Request
URI
| Methods | URL |
|---|---|
| POST | /v1/siems/externalSearch |
URI Parameters
| Name | Type | 필수 | Description |
|---|
Request Headers
| Name | Type | 필수 | Description |
|---|---|---|---|
| Referer | string | true | 라이선스 등록 시 사용된 연동 서비스스 도메인 |
Request Body
| Name | Type | 필수 | Description |
|---|---|---|---|
| size | int | true | 검색 결과중 가져올 목록 수 |
| from | timestamp | true | 로그 조회 시작 기간, 아래 샘플 데이터 참고 |
| to | timestamp | true | 로그 조회 종료 기간, 아래 샘플 데이터 참고 |
| sort | array | true | 정렬 조건 배열 |
| pagination_key | array | false | 페이징 기준값을 지정하는 배열(응답 결과의 sort 값을 그대로 사용) |
| license | string | true | 검색대상 라이선스 |
Response
성공 HTTP Status Code 200 Body (JSON 형식)
| Name | Type | Description |
|---|---|---|
| code | int | 0 |
| msg | string | |
| total | int | 검색 전체수 |
| items | json array | 조건을 만족하는 통합로그에 등록된 목록 (json) |
실패 HTTP Status Code
| HTTP status code | HTTP 메시지 | 설명 |
|---|---|---|
| 400 | Bad Request | 요청 정보 오류 |
| 401 | Unauthorized | 권한 없음 |
| 403 | Forbidden | |
| 404 | Not Found | |
| 429 | Request limit exceeded | 요청 제한 초과 |
| 500 | Internal Server Error | 예외발생 |
| 61001 | fail to search | 검색 실패 |
| 61002 | Referer does not match system domain | Referer와 SystemDomain 불일치 |
| 61003 | JSON conversion error | JSON 변환 오류 |
Example
요청
POST /v1/siems/externalSearch
Referer: https://example.com/app
Content-Type: application/json; charset=utf-8
{
"size": 3,
"from": 1752764400000,
"to": 1753455599999,
"sort": [
{
"time": "desc"
},
{
"_id": "asc"
}
],
"license": "HWIX-1DGC0-MKQ6-B2HAF"
}
페이징 추가 요청
POST /v1/siems/externalSearch
Referer: https://example.com/app
Content-Type: application/json; charset=utf-8
{
"size": 3,
"from": 1752764400000,
"to": 1753455599999,
"sort": [
{
"time": "desc"
},
{
"_id": "asc"
}
],
"pagination_key": [
1753410386053,
"78E122C03502CFABC33ECC0FE2D9B682AD11BDDCF7FFC3C09D47C428BA41013A"
],
"license": "HWIX-1DGC0-MKQ6-B2HAF"
}
응답
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 0,
"msg": "",
"total": 3,
"items": [
{
"traceId": "115cf83e-68ff-11f0-81f6-42aa5db897b7",
"time": 1753410514870,
"ip": "10.10.31.187",
"userId": "master@socam.info",
"logLevel": "INFO",
"logType": "ADMIN",
"brandName": "Security365 Portal",
"serviceName": "SPSVR",
"tenantId": "3CJ55MSE-xLO7Sxt4-qUBKzbcs-XP2cgGEq",
"target": "",
"event": "USER_LOG_MENU_READ",
"description": "/user-log",
"detail": "",
"corp": {
"id": "3CJ55MSE-xLO7Sxt4-qUBKzbcs-XP2cgGEq"
},
"user": {
"id": "master@socam.info",
"name": "최고관리자"
},
"file": {},
"folder": {},
"device": {},
"process": {},
"source": {},
"branch": {},
"drmDoc": null,
"policy": null,
"storage": null,
"urlFile": null,
"edgeServer": null,
"workSystem": null,
"mail": {},
"sensitive": null,
"taskId": "",
"serviceId": "f94e02e6-0873-4cd4-82a7-0da466b9736e",
"serviceHostname": "cloud-spsvr-service-b59c89859-ql2qr",
"crc32": 1131255710,
"sort": [
1753410514870,
"99E50430D86055AE9E5467C27457879D6C453B7AEB616B22EB97BC58D1AADA12"
],
"detail6000": null,
"category": 0
},
{
"traceId": "0fa7ce2d-68ff-11f0-81f6-42aa5db897b7",
"time": 1753410512009,
"ip": "10.10.31.187",
"userId": "master@socam.info",
"logLevel": "INFO",
"logType": "ADMIN",
"brandName": "Security365 Portal",
"serviceName": "SPSVR",
"tenantId": "3CJ55MSE-xLO7Sxt4-qUBKzbcs-XP2cgGEq",
"target": "",
"event": "USER_LOG_MENU_READ",
"description": "/user-log",
"detail": "",
"corp": {
"id": "3CJ55MSE-xLO7Sxt4-qUBKzbcs-XP2cgGEq"
},
"user": {
"id": "master@socam.info",
"name": "최고관리자"
},
"file": {},
"folder": {},
"device": {},
"process": {},
"source": {},
"branch": {},
"drmDoc": null,
"policy": null,
"storage": null,
"urlFile": null,
"edgeServer": null,
"workSystem": null,
"mail": {},
"sensitive": null,
"taskId": "",
"serviceId": "f94e02e6-0873-4cd4-82a7-0da466b9736e",
"serviceHostname": "cloud-spsvr-service-b59c89859-ql2qr",
"crc32": 1659548201,
"sort": [
1753410512009,
"D5757F2F9920978B4E316AA80FA77AF39619BF797C205E89A5F345D70CED6790"
],
"detail6000": null,
"category": 0
},
{
"traceId": "3CJ55MSE-xLO7Sxt4-qUBKzbcs-XP2cgGEq",
"time": 1753410386053,
"ip": "10.10.31.187",
"userId": "7325bbd0-9d1f-4f6d-8b0a-b7d97188d4bd",
"logLevel": "INFO",
"logType": "APP",
"brandName": "",
"serviceName": "IdGP",
"tenantId": "3CJ55MSE-xLO7Sxt4-qUBKzbcs-XP2cgGEq",
"target": "",
"event": "POST_COMMON_OAUTH_TOKEN",
"description": "Acquire client token",
"detail": "{\"reqAppName\":\"InfoLineage\",\"reqAppId\":\"7325bbd0-9d1f-4f6d-8b0a-b7d97188d4bd\",\"userAgent\":{\"operatingSystemName\":\"Unknown\",\"operatingSystemNameVersion\":\"Unknown\",\"agentName\":\"RestClient_53220\",\"agentVersion\":\"1.0.11\",\"deviceClass\":\"Unknown\",\"deviceName\":\"Unknown\",\"client\":null},\"grantType\":\"client_credentials\",\"email\":\"\"}",
"corp": {
"id": "3CJ55MSE-xLO7Sxt4-qUBKzbcs-XP2cgGEq"
},
"user": {},
"file": {},
"folder": {},
"device": {},
"process": {},
"source": {},
"branch": {},
"drmDoc": null,
"policy": null,
"storage": null,
"urlFile": null,
"edgeServer": null,
"workSystem": null,
"mail": {},
"sensitive": null,
"taskId": "",
"serviceId": "cloud-oauth-service",
"serviceHostname": "cloud-oauth-service-549f7db694-wdhcw",
"crc32": 1947451918,
"sort": [
1753410386053,
"78E122C03502CFABC33ECC0FE2D9B682AD11BDDCF7FFC3C09D47C428BA41013A"
],
"detail6000": null,
"category": 0
}
]
}